<!DOCTYPE html>
<html>
<head>
<title>13</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<style type="text/css">
/* GitHub stylesheet for MarkdownPad (http://markdownpad.com) */
/* Author: Nicolas Hery - http://nicolashery.com */
/* Version: b13fe65ca28d2e568c6ed5d7f06581183df8f2ff */
/* Source: https://github.com/nicolahery/markdownpad-github */

/* RESET
=============================================================================*/

html, body, div, span, applet, object, iframe, h1, h2, h3, h4, h5, h6, p, blockquote, pre, a, abbr, acronym, address, big, cite, code, del, dfn, em, img, ins, kbd, q, s, samp, small, strike, strong, sub, sup, tt, var, b, u, i, center, dl, dt, dd, ol, ul, li, fieldset, form, label, legend, table, caption, tbody, tfoot, thead, tr, th, td, article, aside, canvas, details, embed, figure, figcaption, footer, header, hgroup, menu, nav, output, ruby, section, summary, time, mark, audio, video {
  margin: 0;
  padding: 0;
  border: 0;
}

/* BODY
=============================================================================*/

body {
  font-family: Helvetica, arial, freesans, clean, sans-serif;
  font-size: 14px;
  line-height: 1.6;
  color: #333;
  background-color: #fff;
  padding: 20px;
  max-width: 960px;
  margin: 0 auto;
}

body>*:first-child {
  margin-top: 0 !important;
}

body>*:last-child {
  margin-bottom: 0 !important;
}

/* BLOCKS
=============================================================================*/

p, blockquote, ul, ol, dl, table, pre {
  margin: 15px 0;
}

/* HEADERS
=============================================================================*/

h1, h2, h3, h4, h5, h6 {
  margin: 20px 0 10px;
  padding: 0;
  font-weight: bold;
  -webkit-font-smoothing: antialiased;
}

h1 tt, h1 code, h2 tt, h2 code, h3 tt, h3 code, h4 tt, h4 code, h5 tt, h5 code, h6 tt, h6 code {
  font-size: inherit;
}

h1 {
  font-size: 28px;
  color: #000;
}

h2 {
  font-size: 24px;
  border-bottom: 1px solid #ccc;
  color: #000;
}

h3 {
  font-size: 18px;
}

h4 {
  font-size: 16px;
}

h5 {
  font-size: 14px;
}

h6 {
  color: #777;
  font-size: 14px;
}

body>h2:first-child, body>h1:first-child, body>h1:first-child+h2, body>h3:first-child, body>h4:first-child, body>h5:first-child, body>h6:first-child {
  margin-top: 0;
  padding-top: 0;
}

a:first-child h1, a:first-child h2, a:first-child h3, a:first-child h4, a:first-child h5, a:first-child h6 {
  margin-top: 0;
  padding-top: 0;
}

h1+p, h2+p, h3+p, h4+p, h5+p, h6+p {
  margin-top: 10px;
}

/* LINKS
=============================================================================*/

a {
  color: #4183C4;
  text-decoration: none;
}

a:hover {
  text-decoration: underline;
}

/* LISTS
=============================================================================*/

ul, ol {
  padding-left: 30px;
}

ul li > :first-child, 
ol li > :first-child, 
ul li ul:first-of-type, 
ol li ol:first-of-type, 
ul li ol:first-of-type, 
ol li ul:first-of-type {
  margin-top: 0px;
}

ul ul, ul ol, ol ol, ol ul {
  margin-bottom: 0;
}

dl {
  padding: 0;
}

dl dt {
  font-size: 14px;
  font-weight: bold;
  font-style: italic;
  padding: 0;
  margin: 15px 0 5px;
}

dl dt:first-child {
  padding: 0;
}

dl dt>:first-child {
  margin-top: 0px;
}

dl dt>:last-child {
  margin-bottom: 0px;
}

dl dd {
  margin: 0 0 15px;
  padding: 0 15px;
}

dl dd>:first-child {
  margin-top: 0px;
}

dl dd>:last-child {
  margin-bottom: 0px;
}

/* CODE
=============================================================================*/

pre, code, tt {
  font-size: 12px;
  font-family: Consolas, "Liberation Mono", Courier, monospace;
}

code, tt {
  margin: 0 0px;
  padding: 0px 0px;
  white-space: nowrap;
  border: 1px solid #eaeaea;
  background-color: #f8f8f8;
  border-radius: 3px;
}

pre>code {
  margin: 0;
  padding: 0;
  white-space: pre;
  border: none;
  background: transparent;
}

pre {
  background-color: #f8f8f8;
  border: 1px solid #ccc;
  font-size: 13px;
  line-height: 19px;
  overflow: auto;
  padding: 6px 10px;
  border-radius: 3px;
}

pre code, pre tt {
  background-color: transparent;
  border: none;
}

kbd {
    -moz-border-bottom-colors: none;
    -moz-border-left-colors: none;
    -moz-border-right-colors: none;
    -moz-border-top-colors: none;
    background-color: #DDDDDD;
    background-image: linear-gradient(#F1F1F1, #DDDDDD);
    background-repeat: repeat-x;
    border-color: #DDDDDD #CCCCCC #CCCCCC #DDDDDD;
    border-image: none;
    border-radius: 2px 2px 2px 2px;
    border-style: solid;
    border-width: 1px;
    font-family: "Helvetica Neue",Helvetica,Arial,sans-serif;
    line-height: 10px;
    padding: 1px 4px;
}

/* QUOTES
=============================================================================*/

blockquote {
  border-left: 4px solid #DDD;
  padding: 0 15px;
  color: #777;
}

blockquote>:first-child {
  margin-top: 0px;
}

blockquote>:last-child {
  margin-bottom: 0px;
}

/* HORIZONTAL RULES
=============================================================================*/

hr {
  clear: both;
  margin: 15px 0;
  height: 0px;
  overflow: hidden;
  border: none;
  background: transparent;
  border-bottom: 4px solid #ddd;
  padding: 0;
}

/* TABLES
=============================================================================*/

table th {
  font-weight: bold;
}

table th, table td {
  border: 1px solid #ccc;
  padding: 6px 13px;
}

table tr {
  border-top: 1px solid #ccc;
  background-color: #fff;
}

table tr:nth-child(2n) {
  background-color: #f8f8f8;
}

/* IMAGES
=============================================================================*/

img {
  max-width: 100%
}
</style>
</head>
<body>
<h2>API客户端对接</h2>
<h3>接口协议</h3>
<p><strong>URL</strong>： </p>
<ul>
<li>格式： [http | https]://{域名}/{接口版本号}/{接口服务名}/[auth | nuauth]/{URI}</li>
<li>必要： 接口服务名，接口版本号（网关端控制），认证标识(auth | unauth)</li>
<li>注： 接口版本号由网关端控制，以便匹配网关端功能升级；业务端可以在URI里面加入版本号，控制业务端功能升级；</li>
<li>接口服务名：统一有kong-admin管理，登记服务名，负责人，联系方式，对外发布时间，备注信息</li>
<li>接口版本号：格式 v1，v2，vn... 以此类推</li>
</ul>
<p><strong>协议</strong>： HTTP | HTTPS</p>
<p><strong>方法</strong>：</p>
<pre><code>GET
获取Request-URI作为其标识的资源

PUT
新增存储一个资源，并用Request-URI作为其标识

POST
附加Request-URI所标识的资源新的数据

PATCH
更新由Request-URI所标识的资源的数据

DELETE
删除Request-URI所标识的资源
</code></pre>

<p><strong>请求体格式</strong>： JSON</p>
<p>{</p>
<pre><code>  data:””,

  key:””,

  sign:””,

  code:””
</code></pre>

<p>}</p>
<p>data:</p>
<pre><code>业务数据  【加密： 请求体业务数据，已完成对称加密（3DES）】
</code></pre>

<p>key:</p>
<pre><code>盐值    【加解密插件生效时可用】   【盐值：对称加密（3DES）的key，key值使用RSA加密】
</code></pre>

<p>sign:</p>
<pre><code>签名   【对token，key，data的签名数据，防止数据传输中篡改】
</code></pre>

<p>code:</p>
<pre><code>状态码  【建议：失败码小于等于0，成功码大于0】
</code></pre>

<p><strong>【关键状态码】</strong></p>
<ul>
<li>【成功】默认码： 1</li>
<li>【失败】默认码： 0</li>
<li>【限流拒绝】码： 503</li>
<li>【限流失败】码： 500</li>
<li>【token认证失败】码： -100</li>
<li>【停机维护】推荐码： 999</li>
<li>【局部停机维护】推荐码：998</li>
</ul>
<h3>网关接口配置</h3>
<p><img src="13_images\13.png" alt="13" /></p>
<ul>
<li>名称：	定义API名称</li>
<li>uris：	对外访问URI  例如：/{接口版本号}/{接口服务名}/[auth | nuauth]/my-path。注： 必须符合约束规则！</li>
<li>请求方法：	HTTP请求方法： GET,PUT,POST,PATCH,DELETE</li>
<li>网址：	反向代理的转发服务地址。该url将用于代理请求。例如：http://example.com，格式：http://{upstreamName}。</li>
<li>是否去掉uris前缀：	是 当通过uris前缀匹配API时，应去掉请求地址中的前缀。默认true。</li>
<li>重连次数： 	未能请求成功时的重连次数。默认5次。</li>
<li>连接超时时间：	与服务器建立连接的超时时间（以毫秒为单位），默认60000ms。</li>
<li>发送超时时间：	连续两次向服务器请求写操作之间的超时时间（以毫秒为单位），默认60000ms。</li>
<li>读取超时时间：	连续两次向服务器请求读取操作之间的超时时间（以毫秒为单位），默认60000ms。</li>
<li>是否只允许https：	是 如果想仅通过https访问API，请选用合适的端口号(默认为8443)。默认false。</li>
</ul>
<h3>客户端对接</h3>
<p><img src="13_images\131.png" alt="131" /></p>
<p>未接入其他功能插件的情况下，客户端只需要按API配置uris进行访问，如： http://example.com/api</p>
<h3>插件配置</h3>
<p><img src="13_images\133.png" alt="133" /></p>
<ul>
<li>通过API接口进入插件添加页面</li>
<li>API名称： 插件配置的接口名称</li>
<li>插件名： 下拉可选当前生效插件，按功能需求选择；</li>
<li>选择不同插件，会对应不同的配置参数，具体请参考： 【插件解析】</li>
</ul>

</body>
</html>
<!-- This document was created with MarkdownPad, the Markdown editor for Windows (http://markdownpad.com) -->
